<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>MapResourceOrganizer xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/com/cerner/system/rest/resource/organizer/MapResourceOrganizer.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright (c) 2009 Cerner Corporation.</em>
<a name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * All rights reserved. This program and the accompanying materials</em>
<a name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> * are made available under the terms of the Eclipse Public License v1.0</em>
<a name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * which accompanies this distribution, and is available at</em>
<a name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * <a href="http://www.eclipse.org/legal/epl-v10.html" target="alexandria_uri">http://www.eclipse.org/legal/epl-v10.html</a></em>
<a name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> *</em>
<a name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> * Contributors:</em>
<a name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> *    Cerner Corporation - initial API and implementation</em>
<a name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> */</em>
<a name="11" href="#11">11</a>  <strong class="jxr_keyword">package</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.resource.organizer;
<a name="12" href="#12">12</a>  
<a name="13" href="#13">13</a>  <strong class="jxr_keyword">import</strong> java.net.URI;
<a name="14" href="#14">14</a>  <strong class="jxr_keyword">import</strong> java.util.Collection;
<a name="15" href="#15">15</a>  
<a name="16" href="#16">16</a>  <strong class="jxr_keyword">import</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.internal.arguments.BaseUriValidator;
<a name="17" href="#17">17</a>  <strong class="jxr_keyword">import</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.internal.arguments.NotNullValidator;
<a name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.internal.arguments.Verifier;
<a name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.resource.organizer.spi.NotThreadSafe;
<a name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> com.cerner.system.<strong class="jxr_keyword">rest</strong>.resource.organizer.spi.ResourceKey;
<a name="21" href="#21">21</a>  
<a name="22" href="#22">22</a>  <em class="jxr_javadoccomment">/**</em>
<a name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * Implementation of the {@link ResourceOrganizer} API that stores resource</em>
<a name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> * representations in a {@link java.util.Map} data structure.</em>
<a name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> * </em>
<a name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * @author Alex Horn</em>
<a name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * @param &lt;E&gt; class type of objects that should be cached</em>
<a name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> */</em>
<a name="29" href="#29">29</a>  @NotThreadSafe
<a name="30" href="#30">30</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> MapResourceOrganizer&lt;E&gt; implements ResourceOrganizer&lt;E&gt; {
<a name="31" href="#31">31</a>  
<a name="32" href="#32">32</a>    <em class="jxr_javadoccomment">/**</em>
<a name="33" href="#33">33</a>  <em class="jxr_javadoccomment">   * URIs which is used to {@link java.net.URI#resolve(java.net.URI) resolve}</em>
<a name="34" href="#34">34</a>  <em class="jxr_javadoccomment">   * resource URIs must not be {@code null} and it must conform to the absolute</em>
<a name="35" href="#35">35</a>  <em class="jxr_javadoccomment">   * URI syntax.</em>
<a name="36" href="#36">36</a>  <em class="jxr_javadoccomment">   * </em>
<a name="37" href="#37">37</a>  <em class="jxr_javadoccomment">   * @see BaseUriValidator</em>
<a name="38" href="#38">38</a>  <em class="jxr_javadoccomment">   * @see NotNullValidator</em>
<a name="39" href="#39">39</a>  <em class="jxr_javadoccomment">   */</em>
<a name="40" href="#40">40</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../../../com/cerner/system/rest/internal/arguments/Verifier.html">Verifier</a> BASE_URI_VERIFIER;
<a name="41" href="#41">41</a>  
<a name="42" href="#42">42</a>    <strong class="jxr_keyword">static</strong> {
<a name="43" href="#43">43</a>      BASE_URI_VERIFIER = <strong class="jxr_keyword">new</strong> <a href="../../../../../../com/cerner/system/rest/internal/arguments/Verifier.html">Verifier</a>(<strong class="jxr_keyword">new</strong> <a href="../../../../../../com/cerner/system/rest/internal/arguments/NotNullValidator.html">NotNullValidator</a>(),
<a name="44" href="#44">44</a>          <strong class="jxr_keyword">new</strong> <a href="../../../../../../com/cerner/system/rest/internal/arguments/BaseUriValidator.html">BaseUriValidator</a>());
<a name="45" href="#45">45</a>    }
<a name="46" href="#46">46</a>  
<a name="47" href="#47">47</a>    <em class="jxr_javadoccomment">/**</em>
<a name="48" href="#48">48</a>  <em class="jxr_javadoccomment">   * Internal map data structure used to store, organize and access cached</em>
<a name="49" href="#49">49</a>  <em class="jxr_javadoccomment">   * objects.</em>
<a name="50" href="#50">50</a>  <em class="jxr_javadoccomment">   */</em>
<a name="51" href="#51">51</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> java.util.Map&lt;ResourceKey, MapResourceRef&lt;E&gt;&gt; map;
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>    <em class="jxr_javadoccomment">/**</em>
<a name="54" href="#54">54</a>  <em class="jxr_javadoccomment">   * @see #BASE_URI_VERIFIER</em>
<a name="55" href="#55">55</a>  <em class="jxr_javadoccomment">   */</em>
<a name="56" href="#56">56</a>    <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> java.net.URI baseURI;
<a name="57" href="#57">57</a>  
<a name="58" href="#58">58</a>    <em class="jxr_javadoccomment">/**</em>
<a name="59" href="#59">59</a>  <em class="jxr_javadoccomment">   * Instantiate a {@link ResourceOrganizer} object that stores resources in a</em>
<a name="60" href="#60">60</a>  <em class="jxr_javadoccomment">   * {@link java.util.Map} data structure. Note that it is not thread-safe.</em>
<a name="61" href="#61">61</a>  <em class="jxr_javadoccomment">   * &lt;p&gt;</em>
<a name="62" href="#62">62</a>  <em class="jxr_javadoccomment">   * The base URI is used to {@link #resource(java.net.URI) resolve} resource</em>
<a name="63" href="#63">63</a>  <em class="jxr_javadoccomment">   * URIs.</em>
<a name="64" href="#64">64</a>  <em class="jxr_javadoccomment">   * </em>
<a name="65" href="#65">65</a>  <em class="jxr_javadoccomment">   * @param baseURI base URI must conform to the &lt;a</em>
<a name="66" href="#66">66</a>  <em class="jxr_javadoccomment">   *          href="<a href="http://tools.ietf.org/html/rfc3986" target="alexandria_uri">http://tools.ietf.org/html/rfc3986</a>#section-4.3"</em>
<a name="67" href="#67">67</a>  <em class="jxr_javadoccomment">   *          &gt;&amp;lt;absolute-URI&amp;gt; syntax rule&lt;/a&gt;</em>
<a name="68" href="#68">68</a>  <em class="jxr_javadoccomment">   * @throws IllegalArgumentException if the base URI is {@code null} or it does</em>
<a name="69" href="#69">69</a>  <em class="jxr_javadoccomment">   *           not conform to the &lt;a</em>
<a name="70" href="#70">70</a>  <em class="jxr_javadoccomment">   *           href="<a href="http://tools.ietf.org/html/rfc3986" target="alexandria_uri">http://tools.ietf.org/html/rfc3986</a>#section-4.3"</em>
<a name="71" href="#71">71</a>  <em class="jxr_javadoccomment">   *           &gt;&amp;lt;absolute-URI&amp;gt; syntax rule&lt;/a&gt;</em>
<a name="72" href="#72">72</a>  <em class="jxr_javadoccomment">   */</em>
<a name="73" href="#73">73</a>    <strong class="jxr_keyword">public</strong> <a href="../../../../../../com/cerner/system/rest/resource/organizer/MapResourceOrganizer.html">MapResourceOrganizer</a>(<strong class="jxr_keyword">final</strong> java.net.URI baseURI) {
<a name="74" href="#74">74</a>      checkBaseURI(baseURI);
<a name="75" href="#75">75</a>  
<a name="76" href="#76">76</a>      <strong class="jxr_keyword">this</strong>.map = <strong class="jxr_keyword">new</strong> java.util.HashMap&lt;ResourceKey, MapResourceRef&lt;E&gt;&gt;();
<a name="77" href="#77">77</a>      <strong class="jxr_keyword">this</strong>.baseURI = baseURI;
<a name="78" href="#78">78</a>    }
<a name="79" href="#79">79</a>  
<a name="80" href="#80">80</a>    <strong class="jxr_keyword">public</strong> URI baseURI() {
<a name="81" href="#81">81</a>      <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.baseURI;
<a name="82" href="#82">82</a>    }
<a name="83" href="#83">83</a>  
<a name="84" href="#84">84</a>    <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clear() {
<a name="85" href="#85">85</a>      <strong class="jxr_keyword">this</strong>.map.clear();
<a name="86" href="#86">86</a>    }
<a name="87" href="#87">87</a>  
<a name="88" href="#88">88</a>    <strong class="jxr_keyword">public</strong> MapResourceController&lt;E&gt; resource(<strong class="jxr_keyword">final</strong> java.net.URI uri) {
<a name="89" href="#89">89</a>      <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> MapResourceController&lt;E&gt;(<strong class="jxr_keyword">new</strong> <a href="../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a>(baseURI(), uri), <strong class="jxr_keyword">this</strong>);
<a name="90" href="#90">90</a>    }
<a name="91" href="#91">91</a>  
<a name="92" href="#92">92</a>    <em class="jxr_javadoccomment">/**</em>
<a name="93" href="#93">93</a>  <em class="jxr_javadoccomment">   * Internal API to place a {@link MapResourceRef} in the underlying map data</em>
<a name="94" href="#94">94</a>  <em class="jxr_javadoccomment">   * structure.</em>
<a name="95" href="#95">95</a>  <em class="jxr_javadoccomment">   * </em>
<a name="96" href="#96">96</a>  <em class="jxr_javadoccomment">   * @param key key that uniquely identifies a resource in the map</em>
<a name="97" href="#97">97</a>  <em class="jxr_javadoccomment">   * @param node resource tree node to be stored in map</em>
<a name="98" href="#98">98</a>  <em class="jxr_javadoccomment">   */</em>
<a name="99" href="#99">99</a>    <strong class="jxr_keyword">void</strong> put(<strong class="jxr_keyword">final</strong> <a href="../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a> key, <strong class="jxr_keyword">final</strong> MapResourceRef&lt;E&gt; node) {
<a name="100" href="#100">100</a>     <strong class="jxr_keyword">this</strong>.map.put(key, node);
<a name="101" href="#101">101</a>   }
<a name="102" href="#102">102</a> 
<a name="103" href="#103">103</a>   <em class="jxr_javadoccomment">/**</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment">   * Internal API to remove all {@link MapResourceRef} objects from the cache</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment">   * that match the provided keys.</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment">   * </em>
<a name="107" href="#107">107</a> <em class="jxr_javadoccomment">   * @param keys set of keys that identify resources to be removed from the map</em>
<a name="108" href="#108">108</a> <em class="jxr_javadoccomment">   */</em>
<a name="109" href="#109">109</a>   <strong class="jxr_keyword">void</strong> removeAll(<strong class="jxr_keyword">final</strong> Collection&lt;ResourceKey&gt; keys) {
<a name="110" href="#110">110</a>     <strong class="jxr_keyword">for</strong> (ResourceKey key : keys) {
<a name="111" href="#111">111</a>       <strong class="jxr_keyword">this</strong>.map.remove(key);
<a name="112" href="#112">112</a>     }
<a name="113" href="#113">113</a>   }
<a name="114" href="#114">114</a> 
<a name="115" href="#115">115</a>   <em class="jxr_javadoccomment">/**</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment">   * Internal API to retrieve a particular {@link MapResourceRef} object that is</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment">   * stored in the map.</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment">   * </em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment">   * @param key key that uniquely identifies the resources that should be</em>
<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">   *          retrieved</em>
<a name="121" href="#121">121</a> <em class="jxr_javadoccomment">   * @return node that represents the state of a resource in the tree data</em>
<a name="122" href="#122">122</a> <em class="jxr_javadoccomment">   *         structure</em>
<a name="123" href="#123">123</a> <em class="jxr_javadoccomment">   */</em>
<a name="124" href="#124">124</a>   MapResourceRef&lt;E&gt; get(<strong class="jxr_keyword">final</strong> <a href="../../../../../../com/cerner/system/rest/resource/organizer/spi/ResourceKey.html">ResourceKey</a> key) {
<a name="125" href="#125">125</a>     <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.map.get(key);
<a name="126" href="#126">126</a>   }
<a name="127" href="#127">127</a> 
<a name="128" href="#128">128</a>   <em class="jxr_javadoccomment">/**</em>
<a name="129" href="#129">129</a> <em class="jxr_javadoccomment">   * Throws an {@link IllegalArgumentException} if the provided URI is {@code</em>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">   * null} or it does not conform to the &lt;a</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment">   * href="<a href="http://tools.ietf.org/html/rfc3986" target="alexandria_uri">http://tools.ietf.org/html/rfc3986</a>#section-4.3"&gt;&amp;lt;absolute-URI&amp;gt;</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment">   * syntax rule&lt;/a&gt;.</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment">   * </em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment">   * @param uri URI to check against {@code null} and &amp;lt;absolute-URI&amp;gt;</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment">   *          syntax rule</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment">   */</em>
<a name="137" href="#137">137</a>   <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> checkBaseURI(<strong class="jxr_keyword">final</strong> java.net.URI uri) {
<a name="138" href="#138">138</a>     BASE_URI_VERIFIER.names(<span class="jxr_string">"uri"</span>).values(uri);
<a name="139" href="#139">139</a>   }
<a name="140" href="#140">140</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

